Crate bitcoin_hd
source ·Expand description
Library with extended support of hierarchival deterministic wallet functions.
Includes advanced derivation paths functionality and operations.
Re-exports
pub use account::DerivationAccount;
pub use standards::Bip43;
pub use standards::DerivationStandard;
pub use standards::DescriptorType;
Modules
Module implements LNPBP-32 tracking account type
Derivation schemata based on BIP-43-related standards.
Structs
Derivation path that consisting only of single type of segments.
the provided derive pattern does not match descriptor derivation
wildcard
Index for hardened children derivation; ensures that the index always >=
2^31.
normal derivation index {_0} met when a hardened index was required.
Range of derivation indexes (in form
n..m
) as it can be present in the
derivation path terminal segment according to BIP-88 and LNPBP-32. The range
is always inclusive.Multiple index ranges (in form
a..b, c..d
) as it can be present in the
derivation path segment according to BOP-88 and LNPBP-32. The range is
always inclusive.Index for unhardened children derivation; ensures that the inner value
is always < 2^31
hardened derivation index {_0} met when a normal (unhardened) index was
required.
Descriptor for extended public key which may also hold the information
information about the key origin.
Structure describing origin of some extended key
Deterministic part of the extended public key descriptor
Enums
Derivation segment for the account part of the derivation path as defined by
LNPBP-32 standard
Errors during descriptor derivation
Errors happening when used derivation does not match one requried by a
standard.
Derivation segment for the terminal part of the derivation path as defined
by LNPBP-32 standard
Error parsing
XpubDescriptor
string representationA reference to the used extended public key at some level of a derivation
path.
Errors constructing
XpubOrigin
.Constants
Constant determining BIP32 boundary for u32 values after which index
is treated as hardened
Traits
Extension trait allowing to add more methods to
DerivationPath
typeExtension trait allowing splitting derivation paths into hardened and
unhardened components
Trait defining common API for different types of indexes which may be
present in a certain derivation path segment: hardened, unhardened, mixed.
Extension trait for types containing EC keys, which can be made provably
unspendable